Vcenter Vm Guest CustomizationLive RunSpec
The Vcenter Vm Guest CustomizationLive RunSpec schema contains specification information and authentication that have to be applied to a running virtual machine in the POST /vcenter/vm/{vm}/guest/customization-live?action=run operation
name or spec only supports to be configured as Vcenter Guest ConfigurationSpec.linux_config, also the Vcenter Guest LinuxConfiguration.script_text is not supported yet.
This schema was added in vSphere API 9.0.0.0.
{
"name": "string",
"spec": {
"configuration_spec": {
"windows_config": {
"reboot": "string",
"sysprep": {
"gui_run_once_commands": [
"string"
],
"user_data": {
"computer_name": {
"type": "string",
"fixed_name": "string",
"prefix": "string"
},
"full_name": "string",
"organization": "string",
"product_key": "string"
},
"domain": {
"type": "string",
"workgroup": "string",
"domain": "string",
"domain_username": "string",
"domain_password": "string",
"domain_ou": "string"
},
"gui_unattended": {
"auto_logon": false,
"auto_logon_count": 0,
"password": "string",
"time_zone": 0
}
},
"sysprep_xml": "string"
},
"linux_config": {
"hostname": {
"type": "string",
"fixed_name": "string",
"prefix": "string"
},
"domain": "string",
"time_zone": "string",
"script_text": "string",
"compatible_customization_method": "string"
},
"cloud_config": {
"type": "string",
"cloudinit": {
"metadata": "string",
"userdata": "string"
}
}
},
"global_dns_settings": {
"dns_suffix_list": [
"string"
],
"dns_servers": [
"string"
]
},
"interfaces": [
{
"mac_address": "string",
"adapter": {
"ipv4": {
"type": "string",
"ip_address": "string",
"prefix": 0,
"gateways": [
"string"
]
},
"ipv6": {
"type": "string",
"ipv6": [
{
"ip_address": "string",
"prefix": 0
}
],
"gateways": [
"string"
]
},
"windows": {
"dns_servers": [
"string"
],
"dns_domain": "string",
"wins_servers": [
"string"
],
"net_bios_mode": "string"
}
}
}
]
},
"auth": {
"user_name": "string",
"password": "string"
}
}The name of the customization specification that has been retrieved from the virtual center inventory and applied for the virtual machine. Either name or spec should be specified, name and spec can not be missing or null at the same time. If both name and spec are specified, name will be used by default.
This property was added in vSphere API 9.0.0.0.
if spec is missing or null when executing POST /vcenter/vm/{vm}/guest/customization-live?action=run operation, then name should be specified.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vcenter.guest.CustomizationSpec. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vcenter.guest.CustomizationSpec.
The customization specification that has to be applied for the virtual machine. Either name or spec should be specified. name and spec can not be missing or null at the same time. If name and spec are specified, name will be used by default.
This property was added in vSphere API 9.0.0.0.
if name is missing or null when executing POST /vcenter/vm/{vm}/guest/customization-live?action=run operation, then spec should be specified.
The guest authentication data.
This property was added in vSphere API 9.0.0.0.